From ce09b861d0e615769995bbdc24628973713a18bb Mon Sep 17 00:00:00 2001 From: Louis Person Date: Fri, 5 May 2017 22:50:01 +0200 Subject: [PATCH] Document new behavior of crates.io with the documentation field of the manifest --- src/doc/manifest.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/doc/manifest.md b/src/doc/manifest.md index 6d6eb51d3..29ee40262 100644 --- a/src/doc/manifest.md +++ b/src/doc/manifest.md @@ -41,6 +41,15 @@ building native code. More information can be found in the build script build = "build.rs" ``` +## The `documentation` field (optional) + +This field specifies a URL to a website hosting the crate's documentation. +If no URL is specified in the manifest file, [crates.io][cratesio] will +automatically link your crate to the corresponding [docs.rs][docsrs] page. + +[docsrs]: https://docs.rs/ +[cratesio]: https://crates.io/ + ## The `exclude` and `include` fields (optional) You can explicitly specify to Cargo that a set of [globs][globs] should be -- 2.30.2